Skip to content

feat: Add C ABI for embedded seekdb (multi‑language SDKs)#135

Closed
dengfuping wants to merge 523 commits intooceanbase:masterfrom
dengfuping:feat/embedded-mode
Closed

feat: Add C ABI for embedded seekdb (multi‑language SDKs)#135
dengfuping wants to merge 523 commits intooceanbase:masterfrom
dengfuping:feat/embedded-mode

Conversation

@dengfuping
Copy link
Copy Markdown
Collaborator

@dengfuping dengfuping commented Jan 28, 2026 •
edited
Loading

Task Description

Solution Description

  • Architecture Design:
Language Bindings (Node.js, Python, Rust, Go)
           │
           ▼
    SeekDB C ABI (seekdb.h/seekdb.cpp)
           │
           ▼
    OceanBase Core (liboceanbase.so)
  • Source Code Directory (src/include/)
src/include/
├── seekdb.h                          # Public C API header file
│                                     # - All function declarations
│                                     # - Type definitions (SeekdbHandle, SeekdbResult, etc.)
│                                     # - Data structures (SeekdbBind, SeekdbField)
│                                     # - MySQL C API compatible interface
│
├── seekdb.cpp                        # C ABI implementation (~4800 lines)
│                                     # - Global initialization (seekdb_open/close)
│                                     # - Connection management
│                                     # - Query execution & Result set operations
│                                     # - Prepared Statement API
│                                     # - Signal handling & Stack management
│
├── CMakeLists.txt                    # Build configuration for libseekdb.so

Test Directory (unittest/include/)

unittest/include/
├── test_seekdb.cpp                   # C++ unit test suite (comprehensive)
│                                     # - Tests all C API functions directly
│                                     # - Complete API coverage
│
├── nodejs/                           # Node.js FFI binding (koffi)
│   ├── seekdb.js                    # FFI wrapper
│   ├── test.js                      # Test suite
│   └── test.sh                      # Test execution script
│
├── nodejs_napi/                      # Node.js N-API binding (native addon)
│   ├── seekdb.cpp                   # N-API C++ implementation
│   ├── test.js                      # Test suite
│   └── test.sh                      # Test execution script
│
├── python/                           # Python binding (ctypes)
│   ├── seekdb.py                    # FFI wrapper
│   ├── test.py                      # Test suite
│   └── test.sh                      # Test execution script
│
├── rust/                             # Rust FFI binding
│   ├── src/
│   │   ├── lib.rs                   # FFI bindings
│   │   └── test.rs                  # Test suite
│   └── test.sh                      # Test execution script
│
└── go/                               # Go binding (cgo)
    ├── seekdb/seekdb.go              # FFI wrapper
    ├── test.go                       # Test suite
    └── test.sh                       # Test execution script

Passed Regressions

  • Unittest
  • Node.js FFI bindings
  • Node.js N-API bindings
  • Python FFI bindings
  • Go FFI bindings
  • Rust FFI bindings

Build and test:

# build libseekdb library
./build.sh release --init -DBUILD_EMBED_MODE=ON --make

# unittest
make -j$(nproc) test_seekdb
cd build_release/unittest/include && ./test_seekdb

# bindings test
cd unittest/include/nodejs && bash ./test.sh
cd unittest/include/nodejs_napi && bash ./test.sh
cd unittest/include/python && bash ./test.sh
cd unittest/include/go && bash ./test.sh
cd unittest/include/rust && bash ./test.sh

Upgrade Compatibility

  • Compatible

Other Information

Release Note

  • 🆕 Add C ABI for embedded seekdb (multi‑language SDKs).

obdev and others added 30 commits January 19, 2026 16:07
@fkuner @ob-robot
Fix fork table store rebuild to preserve MDS/DDL/memtable state
47d4c0c 
Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
fix: get_access_ctx should fallback to access_ctx_ when tablet_id not…
7d93de4 
… found in extra_access_ctx_

Co-authored-by: fkuner <784819644@qq.com>
@footka @ob-robot
[CP] add the fsync before read macro block during the construction of…
7f8bddf 
… sstable

Co-authored-by: footka <672528926@qq.com>
@hnwyllmm @ob-robot
[hybrid search] support expression in DBMS_HYBRID_SEARCH.GET_SQL
ae25697 
Co-authored-by: hnwyllmm <hnwyllmm@126.com>
@footka @ob-robot
[CP] fix ivf similarity lost data
f443e5a 
Co-authored-by: footka <672528926@qq.com>
@gaopy3 @ob-robot
ObPluginVectorIndexHelper using memory hard limit
e9dd7c5 
Co-authored-by: gaopy3 <gao.panyu@qq.com>
@footka @ob-robot
[CP] dag task错误码被ob cancel覆盖
8252547 
Co-authored-by: footka <672528926@qq.com>
@gaopy3 @ob-robot
add adaptive extend strategy for datafile
d37d2d9 
Co-authored-by: gaopy3 <gao.panyu@qq.com>
@hnwyllmm @ob-robot
change observer to seekdb in errno
c4ac705 
Co-authored-by: hnwyllmm <hnwyllmm@126.com>
@footka @gaopy3 @ob-robot
optimize log block recycle
2a1792b 
Co-authored-by: footka <672528926@qq.com>
Co-authored-by: gaopy3 <gao.panyu@qq.com>
@fkuner @ob-robot
Fix truncate info reset in fork table copy and stabilize fork_table t…
fe058d5 
…est parsing

Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Fix fork task SSTable lifetime by pinning table store iterator in con…
9e2b6ba 
…text

Co-authored-by: fkuner <784819644@qq.com>
@footka @gaopy3 @ob-robot
using ObLinkQueueThreadPool refactor io callback threads
c42e5f7 
Co-authored-by: footka <672528926@qq.com>
Co-authored-by: gaopy3 <gao.panyu@qq.com>
@ob-robot
[CP] [vector index] fix timer scan full schema issue
176a6e1
@shenyunlong @JLY2015 @ob-robot
[CP] fix semantic index post creating failed and the failure of embed…
c9495ba 
…ding for overly long data.

Co-authored-by: shenyunlong.syl <ylshen0919@gmail.com>
Co-authored-by: JLY2015 <1623359870@qq.com>
@footka @gaopy3 @ob-robot
sql memory tracker using hard memory limit
a27dea9 
Co-authored-by: footka <672528926@qq.com>
Co-authored-by: gaopy3 <gao.panyu@qq.com>
@gys-git @ob-robot
update obd version
fe2e493 
Co-authored-by: gys-git <1243106322@qq.com>
@fkuner @ob-robot
Skip in-flight FTS/Vector domain indexes during fork table metadata c…
6f69e92 
…ollection

Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Restrict fork table for semantic/IVF/spatial index tables and update …
3af6c85 
…error tests

Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Fork table: retry snapshot_gc_scn NOWAIT conflict in obtain_snapshot
0eca688 
Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Fork table: avoid clipped schema in index builder; add column_info_si…
ea71375 
…mplified test

Co-authored-by: fkuner <784819644@qq.com>
@footka @LINxiansheng
@LesinLi @ob-robot
Support Mac
bcc69f9 
Co-authored-by: footka <672528926@qq.com>
Co-authored-by: LINxiansheng <wangzelin19961202@gmail.com>
Co-authored-by: LesinLi <15649865651@163.com>
@fkuner @ob-robot
Fix fork-table major merge reuse decision and snapshot filtering duri…
326b6e8 
…ng rewrite

Co-authored-by: fkuner <784819644@qq.com>
@ob-robot
[CP] fix calc param frame size bug
5226ac4
@hnwyllmm @ob-robot
Reduce IK Parser Load Time
87ab54c 
Co-authored-by: hnwyllmm <hnwyllmm@126.com>
@fkuner @ob-robot
Fix refresh order to initialize extra_access_ctx before reset_tables
3dc2114 
Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Remove get_clipped_storage_schema
bbb63c4 
Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Fix fork table schema rebuild API and add build_data major-freeze cases
5904e3b 
Co-authored-by: fkuner <784819644@qq.com>
@fkuner @ob-robot
Fix fork snapshot table selection and row flag output
15a5fe4 
Co-authored-by: fkuner <784819644@qq.com>
@Junkrat77 @ob-robot
chore: update obshell version to 4.4.0.1-12026012311
90b7d79 
Co-authored-by: Junkrat77 <2367392933@qq.com>
@dengfuping dengfuping force-pushed the feat/embedded-mode branch 24 times, most recently from 5bcda7f to f08fdf8 Compare April 23, 2026 10:01
@ob-robot ob-robot force-pushed the master branch 2 times, most recently from 682722e to 993d61e Compare April 23, 2026 13:51
@hnwyllmm hnwyllmm closed this Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature]: Stable C ABI for embedded seekdb (multi‑language SDKs)

2 participants

@dengfuping @hnwyllmm